/*
 * File     : AbstractOpaqueStructure.java
 * Created  : 15 Apr 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.internal.structure;

import com.googlecode.dni.type.structure.Structure;

/**
 * Base class for opaque structures.
 *
 * @author Matthew Wilson
 */
public abstract class AbstractOpaqueStructure extends AbstractStructure
{

    /**
     * @param pointer
     *            the pointer
     */
    public AbstractOpaqueStructure( final long pointer )
    {
        super( pointer );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Structure copy()
    {
        throw new UnsupportedOperationException( "Opaque structure: " + toString() );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final void copyFrom( final Structure other )
    {
        throw new UnsupportedOperationException( "Opaque structure: " + toString() );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean equals( final Object obj )
    {
        if ( obj == null || obj.getClass() != getClass() )
        {
            return false;
        }

        return ( (AbstractOpaqueStructure) obj ).pointer == this.pointer;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int hashCode()
    {
        return (int) ( this.pointer ^ this.pointer >>> 32 );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final String toDebugString()
    {
        return toString();
    }

}
